Motion.StopGroup method

Commands a controlled motion stop and transfers the axis group to the state GroupStopping. It aborts any ongoing method execution. While the axis group is in the GroupStopping state, no other method can perform any motion on this axis group. After the axis group has reached velocity zero, the Done field of KsCommandStatus is set to true immediately. To leave the GroupStopping state and go to GroupStandstill, use Api.AbortCommand.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsCommandStatus StopGroup(
       int Index,
       double Deceleration,
       double Jerk
)

Public Function StopGroup(
       Index As Integer,
       Deceleration As Double,
       Jerk As Double
) As KsCommandStatus

Parameters

Index [in]

Type: int

The index of an axis group. Indexes are zero based. You can have up to 32 groups.

Deceleration [in]

Type: double

A value of the deceleration. The unit is determined by McProfileType. [unit/second²] or [second]

Jerk [in]

Type: double

A value of the jerk. The unit is determined by McProfileType. [unit/second³] or [second]

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Examples

N/A